Add TypeScript runtime actions documentation#521
Merged
Conversation
added 2 commits
March 26, 2026 10:57
App Builder supports TypeScript for runtime actions via Webpack's ts-loader, but this capability was essentially undiscovered because it was not documented in the public docs. This change adds a dedicated guide and cross-links it from existing configuration pages. Changes: - New page: typescript-actions.md covering prerequisites, setup, limitations, and ESM project considerations - webpack-configuration.md: add .cjs extension support (addresses #497) and TypeScript cross-reference - configuration.md: note that function field supports .ts files, add TypeScript Actions to "Learn more" list - index.md: add TypeScript Actions link under Configuration section References: - https://github.com/adobe/aio-cli-plugin-app-dev#typescript-support - #497 Made-with: Cursor
Add the new TypeScript Actions page as a sub-item under Configuration in src/pages/config.md so it appears in the site sidebar navigation. Made-with: Cursor
iivvaannxx
approved these changes
Mar 26, 2026
- Trim Limitations section to only the TypeScript-specific debugging note; link to webpack-configuration.md for general webpack constraints - Clarify that the typescript-app quickstart uses the older manual tsc approach, and that the ts-loader method on this page is simpler Made-with: Cursor
This was referenced Mar 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
typescript-actions.md— Dedicated guide for using TypeScript in Runtime actions, covering prerequisites (ts-loader,typescript), 3-step setup, known limitations, ESM project considerations, and debugging tips.webpack-configuration.md— Added.cjsextension support (addresses webpack configuration can also use the .cjs extension #497) and updated the ES module syntax section with the.cjsworkaround. Added TypeScript cross-reference.configuration.md— Added a note that thefunctionfield supports.tsfiles, and linked to the new TypeScript Actions page.index.md— Added TypeScript Actions to the guides index for discoverability.Motivation
TypeScript support for runtime actions works today via Webpack's
ts-loader, but is not documented in the public docs. The general impression among developers is that TypeScript is not supported for runtime actions. This was raised in the #app-builder Slack channel by Ivan Porto, and confirmed by @shazron who pointed to the aio-cli-plugin-app-dev README as the source of truth.The
.cjsextension change also addresses #497.Test plan
typescript-actions.mdpage renders correctlywebpack-configuration.md,configuration.md, andindex.mdresolve correctly